home *** CD-ROM | disk | FTP | other *** search
/ The World of Computer Software / The World of Computer Software.iso / sfclu12.zip / SFCLU.DOC < prev    next >
Text File  |  1992-01-22  |  6KB  |  144 lines
  1.                            ┌───────────┐
  2.                            │ SFCLU.EXE │
  3.                            └───────────┘
  4.                                  
  5.                  SPITFIRE 3.x Caller's Log Update 
  6.                             Tom Kellen
  7.                    ßETATech Computer Consulting
  8.  
  9. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  10.  
  11. PURPOSE:  Beginning with version 2.9, Spitfire BBS supports multiple
  12.           nodes.  Because of this, during each logon, a file called
  13.           CALLERS.TMP is created in the home directory of each node
  14.           and everything that happens during that session is logged
  15.           to this file.  After the caller's session is over this file
  16.           is appended to the main CALLERS.LOG in the \WORK directory. 
  17.           This little utility will append a line of text to the
  18.           CALLERS.TMP file for the node it was called from.
  19.  
  20.  
  21.  
  22. INTRODUCTION:
  23.  
  24. With the advent of multi-node Spitfire, each node creates a temporary
  25. log file in the home directory of that node.  SFCLU will allow you to
  26. append a line of text to this file.  Basically this is a rewrite of
  27. Bob Zimmerman's excellent SFLOGIT utility which is for versions of
  28. Spitfire prior to 2.9.  SFLOGIT will update the CALLERS.LOG file in
  29. the \WORK directory and because it does this before CALLERS.TMP is
  30. appended to CALLERS.LOG, your CALLERS.LOG will not have the events in
  31. the order they happened.  SFCLU solves this problem on the multi-node
  32. system.  SFCLU has a multitude of uses, it can be called from your
  33. external protocol batch files to indicate that a certain protocol was
  34. used, or from any other batch file to log a happening into your
  35. Spitfire Caller's Log.  SFCLU is written using Buffalo Creek's BCSHARE
  36. Turbo Pascal File Locking and Sharing Unit to be totally compatible
  37. with multi-node use.
  38.  
  39.  
  40.  
  41. INSTALLATION:
  42.  
  43. You will need to place a copy of SFCLU into each node's home
  44. directory.  For instance, if you are running on a network and Node 1
  45. is run from C:\SF and Node 2 is run from F:\SF you would need a copy
  46. of SFCLU.EXE in each of those directories.  If you are multi-tasking
  47. and running Node 1 from C:\SF1 and Node 2 from C:\SF2, place a copy
  48. of SFCLU.EXE in each of those directories.  When SFCLU is run, it will
  49. find the directory it was run from and append it's command line to the
  50. CALLERS.TMP file in that directory.
  51.  
  52.  
  53.  
  54. OPERATION:
  55.  
  56. SFCLU will append the text that is on it's command line to the
  57. CALLERS.TMP file that is in the same directory as the SFCLU.EXE file. 
  58. As an example you might put a line in your external batch file similar
  59. to the following:
  60.  
  61. SFCLU          **ZModem has been used.
  62.  
  63. The line of text (including the leading spaces) will be appended to
  64. the local CALLERS.TMP file.  Now you will know which external protocol
  65. was used.  If you are multi-tasking or both Spitfire Node's home
  66. directories are on the path you should call SFCLU with an explicit
  67. path like this:
  68.  
  69. C:\SF2\SFCLU        **ZModem has been used.
  70.  
  71. Make sure that you test out the number of leading spaces so that the
  72. comment line will line up with the others in your caller's log.  
  73.  
  74. NOTE:     JP Software's 4DOS command processor (COMMAND.COM
  75.           replacement) is a superb program, but for some reason eat's
  76.           the leading spaces you might want to use as we did in the
  77.           example above.  SFCLU can detect when it is running under
  78.           4DOS and will manually insert the 8 spaces that is the
  79.           standard to line up with other items in CALLERS.LOG.  This
  80.           is less flexible but should be acceptable to those running
  81.           their BBS under 4DOS.
  82.  
  83. That is all there is to it.  This will help you keep track of
  84. happenings on your BBS.
  85.  
  86.  
  87.  
  88. EPILOGUE:
  89.  
  90. This is a Free Spitfire utility.  I retain the copyright, but you may
  91. use it to your heart's content.  If you find this utility of use, per-
  92. haps you would consider making a donation (monetarily or in time) to
  93. help our environment.  This is the only planet we will get for a
  94. while!
  95.  
  96.  
  97. AUTHOR CONTACT:
  98.  
  99. Problems, solutions, kudos and ideas are welcomed.  I can be reached
  100. at the following:
  101.  
  102. The Paradigm BBS                   ßETATech Computer Consulting
  103. (404) 671-1581                     P. O. Box 566742
  104. 1200-19,200 Baud 24 Hrs/Day        Atlanta, GA  31156-6013
  105.  
  106.  
  107. DISCLAIMER:
  108.  
  109. Use of this program acknowledges this disclaimer of warranty: "This
  110. program is supplied as is.  ßETATech Computer Consulting disclaims all
  111. warranties, express or implied, including, without limitation, the
  112. warranties of merchantability and of fitness of this program for any
  113. purpose.  ßETATech Computer Consulting assumes no liability for
  114. damages direct or consequential, which may result from the use of this
  115. program."
  116.  
  117.  
  118. ACKNOWLEDGMENTS:
  119.  
  120. My thanks to Mike Woltz for his fine Spitfire BBS Software and for
  121. providing sample Turbo Pascal source code for us novice programmers
  122. and for Buffalo Creek's excellent BCSLOCK Turbo Pascal Unit used for
  123. all file locking and sharing routines in this program.  Thanks to John
  124. Newlin for being an inspirational programmer and providing excellent
  125. shareware to the computing public, and to Sammy Mitchell for his
  126. superb QEdit text editor, how can anyone do without it?  And special
  127. thanks to Bob Zimmerman for writing the original SFLOGIT and for his
  128. BZ_CMD Turbo Pascal Command Line Handling Unit which provided the
  129. inspiration for this program.
  130.  
  131.  
  132.  
  133. REVISION HISTORY:
  134.  
  135. 16-JUL-1990    v1.0      Initial Release.
  136.  
  137. 18-NOV-1990    v1.01     Recompiled with BCShare v0.7 to correct some
  138.                          error checking.
  139.  
  140. 01-DEC-1990    v1.1      Recompiled with Turbo Pascal v6.0.
  141.  
  142. 22-JAN-1992    v1.2      Added automatic 4DOS recognition and default
  143.                          spacing for working under 4DOS.
  144.